home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 23 / CU Amiga - Super CD-ROM 23 (June 1998).iso / CreatingGames / Utilities / Misc / YAME / YAMEv00b.readme < prev   
Encoding:
Text File  |  1991-04-22  |  9.9 KB  |  247 lines
  1. Short:        Yet Another Map Editor v0.0b, by CAT/RST!
  2. Uploader:     blaze@box.net.au (Steven Cooke)
  3. Author:       CAT (Toby Zuijdveld)
  4. Type:         dev/misc/
  5.  
  6.                                /\
  7.       _   _ _  /\___ _   _    //\\__ _   _  /\_ _ /\__/\_ _   /\__/\_  _
  8.  __ _________\//\_____________/  \__________/\____/\  /\  ____/\__/\______
  9. \\_\\____   ¬\/.  ____/   ____/__/   _______   __/  \/  \/ /     \.  ____/
  10.      |   )  _//  __/__\____   \  \_____  \/    \/    \   \ \   \_/  __/__
  11.      |!  |   ¬\       \    \  \\  \    \ \\    \\    \\ \  \\ -/ \       \
  12.      |___|   //_____ //______ //__/_____ //___ //___\//_/\ //__ //DTN__ //
  13.          !___/      \/       \/         \/    \/    \/    \/   \/      \/
  14.                               is proud to present:
  15.  
  16.                       Y A M E   v 0 . 0 b   b y   C A T  !
  17.  
  18. Disclaimer
  19. =-=-=-=-=-=-=-=-=-=-=
  20. I am, and will be, in no way accountable for any mishap that may occur from
  21. the use of this program.  Nyah.
  22.  
  23. What is it?
  24. =-=-=-=-=-=-=-=-=-=-=
  25. Who likes games such as...  SWIV?  And BoulderDash?  And Lemmings?
  26.  
  27. Ever wondered how they managed to cram such a HUGELY big level into a 512k
  28. machine?  Look more closely; see the lazy artists used bits of the same
  29. scenery all over the place?
  30.  
  31. I hate to be the one to tell you, but this wasn't just a boring paintjob.
  32.  
  33. Maybe it would take up a lot less memory, if the artists drew lots of little
  34. `bits' of the background, and the programmer `pasted' them all over the place.
  35.  
  36. The programmer could use the same bits in differant places, eg a cloud, could
  37. be placed at the top of the screen, or at the bottom, or on the sides...
  38.  
  39. OK everyone knows what I'm talking about right?  YAME's a map editor!
  40.  
  41. But there's so many!
  42. =-=-=-=-=-=-=-=-=-=-=
  43. Why another map editor?  Well, cruising around on my local BBS (yes, people
  44. still do that!), the best I could find was MapEd, which didn't support more
  45. than 256 blocks!  I had a rawdata map I wanted to use, and MapEd wouldn't
  46. allow that either.
  47.  
  48. Features
  49. =-=-=-=-=-=-=-=-=-=-=
  50. YAME supports 4 and a half differant types of map layout.  Err.  Sort of :)
  51.               Up to 1024 blocks!
  52.               Saves previews at 5 differant sizes!
  53.               Intuition interface means - EASY TO USE!
  54.               FREEWARE - may be copied freely as long as the contents of this
  55.                          archive remain intact and as whole, no profit must be
  56.                          made for the copying of the archive, magazines, Fred
  57.                          Fish, AmiNet CDs are free to spread this if they so
  58.                          wish.  Commercial releases which use this mapeditor,
  59.                          well, a thankyou letter/maybe a free game would be
  60.                          nice :)
  61.  
  62. Usage
  63. =-=-=-=-=-=-=-=-=-=-=
  64. YAME can be run from either CLI or Workbench.  Tooltypes and CLI arguments are
  65. not supported, but the builtin Prefs editor is decent enough :)
  66.  
  67. The program opens up two windows.  One known as the map window, one as the
  68. block window.
  69.  
  70. In the map window, you edit the mapdata.  Click the left mouse button to
  71. change the current block co-ordinate to the block you last selected...
  72.  
  73. In the block window.  Here you click the left mouse button to select a
  74. differant block.
  75.  
  76. Each window has slider bars which will scroll thru the map/block area,
  77. allowing you to see the whole thing.  Each window is sizeable (only for use
  78. when I get the ScreenModeRequest working! (see Bugs) )
  79.  
  80. Menus
  81. =-=-=-=-=-=-=-=-=-=-=
  82. Project
  83. |-Load
  84. | |-Map         Brings up a requester.  Here you select a map file.  See
  85. | |                     Map Types for more information on the map formats.
  86. | |-Blocks      Here you select an iff file.  Any width and height is
  87. |                       supported.  Each block is cut out to be 16*16 at the
  88. |                       moment.  You should only try to load 2-->256 colour
  89. |                       IFFs for now.
  90. |-Save map
  91. | |-YAME        Saves out the map as the latest YAME format.
  92. | |-FREDIT      Saves out the map in MapEd format (included in archive)
  93. | |-AME         The program for these two formats is also in the archive, but
  94. | |-TAME        incomplete.  I never recieved a complete archive of TAME.
  95. | |-Raw         Saves out in raw format (without a header.)  Not recommended.
  96. | |-Preview     Saves out a preview of your size choice.
  97. |-Preview       Shows a preview of the map.  Asks for differant sizes:
  98. |                       1 - Full size
  99. |                       2 - Half size
  100. |                       3 - Quarter size
  101. |                       4 - Eighth size
  102. |                       5 - Sixteenth size
  103. |-Credits       Brings up a small requester about the program.
  104. |-Quit          Urr...  duh!
  105. |
  106. |-Prefs         Brings up the preferance window.
  107. |
  108. |-New           Creates a new map, filled with block 0.
  109.  
  110. Prefs
  111. =-=-=-=-=-=-=-=-=-=-=
  112. Here you can enter the default x and y sizes (for use with New), the path to
  113. the MapEd.DAT file (for use with Credits), the screenmode and font requestor
  114. (which are both currently disabled.)
  115.  
  116. Also, the button marked Change save prefs, will ask a few questions relating
  117. to the output of the YAME map files.
  118.  
  119. Save, Use and Cancel are self-explanitory.
  120.  
  121. The Prefs will also save out the positions of the block and map windows, for
  122. your convenience.
  123.  
  124. Map Types
  125. =-=-=-=-=-=-=-=-=-=-=
  126. See MapEd and TAME for information on the FREDIT, AME and TAME mapformats.
  127.  
  128. Please note that the .BLK files used with AME and TAME are not supported by
  129. YAME (getting confused?:), only IFFs are.
  130.  
  131. Preview
  132.   The previews are saved out in IFF format, in the number of colours that are
  133.   currently in use by the program.
  134.  
  135. Raw
  136.   These files contain no header, no x and y sizes, just the mapdata.  Can be
  137.   stored in bytes (128 blocks supported), words (1024 blocks) and longwords
  138.   (same as words for now.)  When loading raw maps, YAME will also ask for an
  139.   offset into the file (to avoid weird headers!)
  140.  
  141. AME
  142.   These files have a 6 byte header.  I had to guess the first 4 bytes, and
  143.   the last two are a mystery to me!
  144.  
  145. Offset  Description
  146.   0       Header (word) = $1234
  147.   2       X size (byte)
  148.   3       Y size (byte)
  149.   4-5     ???
  150.   6       Mapdata (words)
  151.  
  152.   The attribute data is not supported (skipped).  YAME will try and load the
  153.   associating block file(s) straight away if it can find any.
  154.  
  155. TAME
  156.   These files don't have headers.  Datas are stored in differant files, which
  157.   is just plain messy.  YAME first looks for the .Dat file, reads the x and y
  158.   sizes and palette information (and uses it too!), then looks for the .Map
  159.   file, and reads the data.
  160.  
  161. FREDIT
  162.   These file have an 8 byte header.  Probably my favourite external format,
  163.   it's just so easy and straightforward :)
  164.  
  165. Offset  Description
  166.   0       Header (4 bytes) = "MAP "
  167.   4       X size (word)
  168.   6       Y size (word)
  169.   8       Mapdata (bytes)
  170.  
  171. There are plenty of examples of the last 4 formats in the Examples/ drawer
  172. to keep you occupied for a few minutes :)
  173.  
  174. YAME
  175.   Well naturally I had to invent my own standard :) YAME map files are stored
  176.   in IFF format.  Chunks may be stored in any order, but must be of the right
  177.   size.  All chunks need not exist, but BODY chunks MUST be the last chunk
  178.   in the file.  Of course it doesn't make sense to exclude the MAPX and MAPY
  179.   chunks :)
  180.  
  181. Offset  Size    Chunk name      Description
  182.   0       4                       Header (4 bytes) = "FORM"
  183.   4       4                       Subheader (4 bytes) = "YAME"
  184.           4       VERS            Version information, only of use to YAME.
  185.                                   (2 words)
  186.           108     PATH            Pathname for blocks file.  (108 bytes)
  187.           32      GFXN            Filename for blocks file.  (32 bytes)
  188.           4       MAPX            X size (longword)
  189.           4       MAPY            Y size (longword)
  190.                   BODY            Mapdata (words) stored in across, downwards
  191.                                   fashion.
  192.  
  193. Bugs (shock, horror!)
  194. =-=-=-=-=-=-=-=-=-=-=
  195. BLITZ!  A common profanity used of late, along with FU...  DGE!
  196.  
  197. OK most of these problems are overcomable, I just don't know how :)
  198.  
  199. RTEZScreenModeRequest and RTEZFontRequest don't actually seem to fill my
  200. variables up with new and interesting data, seems to just leave them be
  201. instead.
  202.  
  203. PICreateRequest doesn't fit on a lores screen <grin>
  204.  
  205. No error checking for statements like Bitmap and Dim means the program will
  206. exit of it's own accord every now and then :)
  207.  
  208. Things to do
  209. =-=-=-=-=-=-=-=-=-=-=
  210. 1)  Fix bugs :)
  211. 2)  Introduce INFO chunk to YAME map standard, for creator's comments and the
  212.         like.  If anyone can see the point in this, tell me and I'll do it.
  213. 3)  Introduce more map formats, if I can get my hands on any.
  214. 4)  I need layout information on the Blitz 2 mapeditor .gps and .mapstuff
  215.         files.  Does anyone know this???
  216. 5)  Introduce the group function, like in Blitz 2 mapeditor.  Very handy!
  217. 6)  Whatever YOU suggest!
  218. 7)  Introduce more bugs :)
  219.  
  220. Thanks go to
  221. =-=-=-=-=-=-=-=-=-=-=
  222.  
  223. (in no particular order)
  224.  
  225. Commodore, Escom and the hundreds of others for going bankrupt :)
  226. ACID Software for producing the best programming tool ever to walk the Earth.
  227. Nico François for creating his excellent reqtools.library.
  228. Neil O'Rourke for creating his excellent ReqTools and Progress BlitzLibs.
  229. Fabrizio Farenga for MapEd v1.5, for which without YAME would never have been
  230.         born.  Maybe :)
  231. Zaphod for FREDITOR, for which without MapEd would never have been born :)
  232. Anthony Ball for TAME and his really ugly mapformats (but they were based on
  233.         Atari ST programs, so I don't really blame you:)
  234. Tiertex for your map editor, which led Anthony to making AME.
  235. Atari for Gauntlet and Gauntlet 2.
  236. The Bitmap Brothers for Speedball.
  237. Ben Campbell and JS Hong for The Caffiene-Free Diet Shoot-Em-Up :)
  238. Dongleware for Catch Em!  (I only used maps on the coverdisk demo!)
  239. Frank Wille for his Phantasm Map Editor (and the nice example map :)
  240.  
  241. Contact me
  242. =-=-=-=-=-=-=-=-=-=-=
  243. Send all your comments, suggestions, criticisms, help, mapformats and
  244. beautiful women to me c/o:  hoss@box.net.au (Ian Hoskins).
  245.  
  246. That's it!  I think.
  247.